yIFrame

Description

The yIFrame is a component to display content of third parties or external content and enable access to it. For example:

• Displaying a static website
• Including YouTube videos

Basic Structure

The basic structure of the yIFrame shall be explained in the following. For the general structure of a yComponent please visit the YBase-components basic-structure.

IFrame

As the name implies, it is a standard IFrame to display external content inside a frame. Multiple style adjustments can be executed to customize the appearance.

Properties

Through its various properties the yIFrame can be configured to suit your needs. The display below provides you with an overview of all the yIFrame properties.

Properties can be changed directly through three methods:

• Inside the Toolbar, which is positioned in your workarea next to your component right where you need it. It shows the most important properties, thus providing a fast and efficient way to configure your component in the most basic way.
• It may also occur in the Toolbar Extension, which is a seamless extension accesible as a dropdown item of the Toolbar. It extends the functionality of the Toolbar by providing advanced pickers for the most used properties.
• Inside the Detail Panel, which is located in the righthand drawer. Every property of a component can be configured here.

Generic

METAread more

Name: componentId

Not Editable

Number Property

--y-i-frame__component-id

The identifier of the component that is unique within a page.

Name: componentType

Not Editable

String Property

--y-i-frame__component-type

The type of the component. For this component it is -i-frame.

Name: name

String Property

--y-i-frame__name

The custom name of the component. It serves for better identification of the component.

Name: version

String Property

--y-i-frame__version

The custom version of the IFrame-component. This can be used to ensure that all components work well together.

Name: coreTheme

String Property

--y-i-frame__core-theme

The CoreTheme, which will be apllied to the IFrame. For further information on themes visit the themes page.

Name: subTheme

String Property

--y-i-frame__sub-theme

The subtheme subordinated to the previously specified CoreTheme, which will be apllied to the IFrame. For further information on themes visit the themes page.

Name: groupTheme

String Property

--y-i-frame__group-theme

The group theme is a further variation of the subtheme which is specified especially for variations of a component inside the subtheme. For further information on themes visit the Theme-Manager page.

DISPLAYread more

Name: display

String Property

--y-i-frame__display

This property specifies the display behavior of the component. This can be be set to:

• none
• block
• flex
• inline

Name: position

Not Editable

String Property

--y-i-frame__position

This property specifies the type of positioning method used for the component. This can be be set to:

• static
• relative
• absolute
• sticky
• fixed

Name: visible

String Property

--y-i-frame__visible

This property can toggle the visibility of the component. The two modes are completely hidden and fully shown.

SIZEread more

Name: minWidth

Injectable

UnitNumber Property

--y-i-frame__min-width

The minimum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: minHeight

Injectable

UnitNumber Property

--y-i-frame__min-height

The minimum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: width

Injectable

UnitNumber Property

--y-i-frame__width

The value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: height

Injectable

UnitNumber Property

--y-i-frame__height

The value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: maxWidth

Injectable

UnitNumber Property

--y-i-frame__max-width

The maximum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: maxHeight

Injectable

UnitNumber Property

--y-i-frame__max-height

The maximum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: flex

String Property

--y-i-frame__flex

The flex property sets the length on flexible items. This sets the value in n-fold shares extrapolated to all other components with the flex display within the same container.

PLACEMENTread more

Name: marginTop

Injectable

UnitNumber Property

--y-i-frame__margin-top

This property creates a space around the component, outside of the top border. This can be set in percent or pixels.

Name: marginRight

Injectable

UnitNumber Property

--y-i-frame__margin-right

This property creates a space around the component, outside of the right border. This can be set in percent or pixels.

Name: marginBottom

Injectable

UnitNumber Property

--y-i-frame__margin-bottom

This property creates a space around the component, outside of the bottom border. This can be set in percent or pixels.

Name: marginLeft

Injectable

UnitNumber Property

--y-i-frame__margin-left

This property creates a space around the component, outside of the left border. This can be set in percent or pixels.

Name: paddingTop

Injectable

UnitNumber Property

--y-i-frame__padding-top

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Name: paddingRight

Injectable

UnitNumber Property

--y-i-frame__padding-right

This property creates a space within the component, inside of the right border. This can be set in percent or pixels.

Name: paddingBottom

Injectable

UnitNumber Property

--y-i-frame__padding-bottom

This property creates a space within the component, inside of the bottom border. This can be set in percent or pixels.

Name: paddingLeft

Injectable

UnitNumber Property

--y-i-frame__padding-left

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Style

BACKGROUNDread more

Name: bgColor

Injectable

Color Property

--y-i-frame__bg-color

--y-i-frame__bg-color__normal

--y-i-frame__bg-color__hover

--y-i-frame__bg-color__focus

--y-i-frame__bg-color__active

--y-i-frame__bg-color__disabled

The color of the background. This can be set as a color from a palette or a custom hex color.

BORDERread more

Name: borderTopColor

Injectable

Color Property

--y-i-frame__border-top-color

--y-i-frame__border-top-color__normal

--y-i-frame__border-top-color__hover

--y-i-frame__border-top-color__focus

--y-i-frame__border-top-color__active

--y-i-frame__border-top-color__disabled

The color of the top border. This can be set as a color from a palette or a custom hex color.

Name: borderTopStyle

Injectable

String Property

--y-i-frame__border-top-style

--y-i-frame__border-top-style__normal

--y-i-frame__border-top-style__hover

--y-i-frame__border-top-style__focus

--y-i-frame__border-top-style__active

--y-i-frame__border-top-style__disabled

The style of the top border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderTopWidth

Injectable

UnitNumber Property

--y-i-frame__border-top-width

--y-i-frame__border-top-width__normal

--y-i-frame__border-top-width__hover

--y-i-frame__border-top-width__focus

--y-i-frame__border-top-width__active

--y-i-frame__border-top-width__disabled

The width of the top border. This can be set in percent or pixels.

Name: borderRightColor

Injectable

Color Property

--y-i-frame__border-right-color

--y-i-frame__border-right-color__normal

--y-i-frame__border-right-color__hover

--y-i-frame__border-right-color__focus

--y-i-frame__border-right-color__active

--y-i-frame__border-right-color__disabled

The color of the right border. This can be set as a color from a palette or a custom hex color.

Name: borderRightStyle

Injectable

String Property

--y-i-frame__border-right-style

--y-i-frame__border-right-style__normal

--y-i-frame__border-right-style__hover

--y-i-frame__border-right-style__focus

--y-i-frame__border-right-style__active

--y-i-frame__border-right-style__disabled

The style of the right border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderRightWidth

Injectable

UnitNumber Property

--y-i-frame__border-right-width

--y-i-frame__border-right-width__normal

--y-i-frame__border-right-width__hover

--y-i-frame__border-right-width__focus

--y-i-frame__border-right-width__active

--y-i-frame__border-right-width__disabled

The width of the right border. This can be set in percent or pixels.

Name: borderBottomColor

Injectable

Color Property

--y-i-frame__border-bottom-color

--y-i-frame__border-bottom-color__normal

--y-i-frame__border-bottom-color__hover

--y-i-frame__border-bottom-color__focus

--y-i-frame__border-bottom-color__active

--y-i-frame__border-bottom-color__disabled

The color of the bottom border. This can be set as a color from a palette or a custom hex color.

Name: borderBottomStyle

Injectable

String Property

--y-i-frame__border-bottom-style

--y-i-frame__border-bottom-style__normal

--y-i-frame__border-bottom-style__hover

--y-i-frame__border-bottom-style__focus

--y-i-frame__border-bottom-style__active

--y-i-frame__border-bottom-style__disabled

The style of the bottom border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderBottomWidth

Injectable

UnitNumber Property

--y-i-frame__border-bottom-width

--y-i-frame__border-bottom-width__normal

--y-i-frame__border-bottom-width__hover

--y-i-frame__border-bottom-width__focus

--y-i-frame__border-bottom-width__active

--y-i-frame__border-bottom-width__disabled

The width of the bottom border. This can be set in percent or pixels.

Name: borderLeftColor

Injectable

Color Property

--y-i-frame__border-left-color

--y-i-frame__border-left-color__normal

--y-i-frame__border-left-color__hover

--y-i-frame__border-left-color__focus

--y-i-frame__border-left-color__active

--y-i-frame__border-left-color__disabled

The color of the left border. This can be set as a color from a palette or a custom hex color.

Name: borderLeftStyle

Injectable

String Property

--y-i-frame__border-left-style

--y-i-frame__border-left-style__normal

--y-i-frame__border-left-style__hover

--y-i-frame__border-left-style__focus

--y-i-frame__border-left-style__active

--y-i-frame__border-left-style__disabled

The style of the left border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderLeftWidth

Injectable

UnitNumber Property

--y-i-frame__border-left-width

--y-i-frame__border-left-width__normal

--y-i-frame__border-left-width__hover

--y-i-frame__border-left-width__focus

--y-i-frame__border-left-width__active

--y-i-frame__border-left-width__disabled

The width of the left border. This can be set in percent or pixels.

Name: borderRadius

Injectable

UnitNumber Property

--y-i-frame__border-radius

The radius of the corners of all the borders. This can be set in percent or pixels.

SHADOWread more

Name: boxShadow

Injectable

String Property

--y-i-frame__box-shadow

--y-i-frame__box-shadow__normal

--y-i-frame__box-shadow__hover

--y-i-frame__box-shadow__focus

--y-i-frame__box-shadow__active

--y-i-frame__box-shadow__disabled

The shadow of the component. This is set by the 4 sub-properties x, y, blur and spread of the shadow-property, which can be further read about in the shadow-property section.

OPACITYread more

Name: opacity

Injectable

Number Property

--y-i-frame__opacity

--y-i-frame__opacity__normal

--y-i-frame__opacity__hover

--y-i-frame__opacity__focus

--y-i-frame__opacity__active

--y-i-frame__opacity__disabled

The opacity of all colored parts of the component. This value is set in percent.

LABELread more

Name: label__fontColor

Injectable

Color Property

--y-i-frame__label__font-color

--y-i-frame__label__font-color__normal

--y-i-frame__label__font-color__hover

--y-i-frame__label__font-color__focus

--y-i-frame__label__font-color__active

--y-i-frame__label__font-color__disabled

The color of the label text. This can be set as a color from a palette or a custom hex color.

Name: label__fontFamily

Injectable

String Property

--y-i-frame__label__font-family

--y-i-frame__label__font-family__normal

--y-i-frame__label__font-family__hover

--y-i-frame__label__font-family__focus

--y-i-frame__label__font-family__active

--y-i-frame__label__font-family__disabled

The font-family of the label text. This can be picked from a large list of provided fonts.

Name: label__fontWeight

Injectable

Number Property

--y-i-frame__label__font-weight

--y-i-frame__label__font-weight__normal

--y-i-frame__label__font-weight__hover

--y-i-frame__label__font-weight__focus

--y-i-frame__label__font-weight__active

--y-i-frame__label__font-weight__disabled

The font-weight of the label text. This can be set in a custom number, as example:

• 400 = normal(regular)
• 500 = medium
• 600 = semi bold
• 700 = bold

Name: label__fontStyle

Injectable

String Property

--y-i-frame__label__font-style

--y-i-frame__label__font-style__normal

--y-i-frame__label__font-style__hover

--y-i-frame__label__font-style__focus

--y-i-frame__label__font-style__active

--y-i-frame__label__font-style__disabled

The font-style of the label text. This can be set to normal, italic or oblique.

Name: label__textTransform

Injectable

String Property

--y-i-frame__label__text-transform

--y-i-frame__label__text-transform__normal

--y-i-frame__label__text-transform__hover

--y-i-frame__label__text-transform__focus

--y-i-frame__label__text-transform__active

--y-i-frame__label__text-transform__disabled

The text-transformation of the label text. This can be set to:

• capitalize
• uppercase
• lowercase
• none
• full-width

Name: label__textDecoration

Injectable

String Property

--y-i-frame__label__text-decoration

--y-i-frame__label__text-decoration__normal

--y-i-frame__label__text-decoration__hover

--y-i-frame__label__text-decoration__focus

--y-i-frame__label__text-decoration__active

--y-i-frame__label__text-decoration__disabled

The text-decoration of the label text. This can be set to:

• strikethrough
• underline

Name: label__fontSize

Injectable

UnitNumber Property

--y-i-frame__label__font-size

The font-size of the label text. This can be set in: -cm

• mm
• in
• px
• em
• ex
• ch
• rem

Name: label__fontAlign

Injectable

String Property

--y-i-frame__label__font-align

The font-align of the label text. This property moves the label text to the desired position, it can be set to left, center or right.

Name: label

String Property

--y-i-frame__label

The actual written text in the label. There is no limit to the number of characters.

ICONread more

Name: iconPosition

String Property

--y-i-frame__icon-position

The position of the icon-element inside the IFrame-component. This can be set to:

• iconLeft
• iconRight
• iconBoth
• none

Name: icon__colorPrimary

Injectable

Color Property

--y-i-frame__icon__color-primary

--y-i-frame__icon__color-primary__normal

--y-i-frame__icon__color-primary__hover

--y-i-frame__icon__color-primary__active

--y-i-frame__icon__color-primary__focus

--y-i-frame__icon__color-primary__disabled

The primary-color of the icon-element inside the IFrame-component. This can be set as a color from a palette or a custom hex color.

Name: icon__colorSecondary

Injectable

Color Property

--y-i-frame__icon__color-secondary

--y-i-frame__icon__color-secondary__normal

--y-i-frame__icon__color-secondary__hover

--y-i-frame__icon__color-secondary__active

--y-i-frame__icon__color-secondary__focus

--y-i-frame__icon__color-secondary__disabled

The secondary-color of the icon-element inside the IFrame-component. This can be set as a color from a palette or a custom hex color.

Name: iconSize

Injectable

UnitNumber Property

--y-i-frame__icon-size

The size of the icon. This can be set in: -cm

• mm
• in
• px

Name: iconLeft

String Property

--y-i-frame__icon-left

The icon to be set as the left icon of the icon-element inside the IFrame-component.

Name: iconRight

String Property

--y-i-frame__icon-right

The icon to be set as the right icon of the icon-element inside the IFrame-component.

IFrame

STATEread more

Name: active

Boolean Property

--y-i-frame__active

This property can disable or enable the active-state of the IFrame-component.

Name: disabled

Boolean Property

--y-i-frame__disabled

This property can disable or enable the disabled-state of the IFrame-component.

TOOLTIPread more

Name: tooltip

String Property

--y-i-frame__tooltip

The text of the tooltip, which is displayed when hovering over the IFrame-component. If you do not insert anything, no tooltip appears.

Name: anchor

String Property

--y-i-frame__anchor

The anchor link that will be displayed inside the tooltip.

Name: self

String Property

--y-i-frame__self

The component itself. ???

MISCread more

Name: toggleMode

Boolean Property

--y-i-frame__toggle-mode

This property can configure the IFrame-component to cause an emit every click or to be used to set a variable true and false.

Events

LIFECYCLEread more

Name: EvtInit

String Property

--y-i-frame__-evt-init

This specifies the function to be called, when the IFrame is initialized.

CONTROLread more

Name: commitCreate

Boolean Property

--y-i-frame__commit-create

If this property is true the IFrame emits a command to create a new entity instance in the database on click. Clipboard

Name: commitRead

Boolean Property

--y-i-frame__commit-read

If this property is true the IFrame emits a command to read an entity instance in the database on click.

Name: commitUpdate

Boolean Property

--y-i-frame__commit-update

If this property is true the IFrame emits a command to update an entity instance in the database on click.

Name: commitDelete

Boolean Property

--y-i-frame__commit-delete

If this property is true the IFrame emits a command to delete an entity instance in the database on click.

INPUTread more

Name: EvtClicked

String Property

--y-i-frame__-evt-clicked

The event that is triggered when clicking inside the input field.

Usage

In this section you will find a collection of application scenarios and examples that illustrate how to leverage the yIFrame in ways that deviate from its standard behavior, as defined by yBase. This section aims to inspire and guide you through various possibilities, helping you to implement more complex or unique functionalities tailored to your specific needs. General properties that are universally applicable can be found in the yBase usage section.

Static website

When working with external ressources, you may want to display other websites or frames of them in your application - e.g. displaying an Instagram feed of your company.

info

The content you want to display, needs to enable being displayed inside an IFrame. Otherwise it won't work as expected.

How to:

1. Open the Detail Panel and proceed to the Style section to open IFrame.
2. Insert the external ressource url or an embedding link into url.

Including YouTube Videos

You can also use our yIFrame to include a YouTube player inside your project.

How to:

1. Open the Detail Panel and proceed to the Style section to open IFrame.
2. In another tab, open the desired YouTube video.
3. Click on share and search for Embed, to copy this link.
4. Go back to yeet and insert this link in the Detail Panel into url.